Edit Task: SetPossibility Timeslot
Description
The SetPossibility Timeslot attribute under EditTask defines the start and stop times for a task assignment possibility.
Parameters
| Parameter | Description |
|---|---|
| PossibilityName | A string of text with a comma delimited list of resources in the possibility, surrounded by single quotes. Order is not required and the resource names should not be in quotes. |
| Start | Represents the start time for a possibility report time. This time should be space delimited and in the same format as the times used in the Time Import Files. The format is YYYY/MM/DD_HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff. |
| Stop | Represents the stop time for a possibility report time. This time should be space delimited and in the same format as the times used in the Time Import Files. The format is YYYY/MM/DD_HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff. |
| PreferredStartTime | Format is YYYY/MM/DD_HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff. This parameter is optional and is used to set a preferred start time within the existing window and must be between TimeslotStartTime and TimeslotStopTime minus the minimum duration of the task. If TimeslotPreferredStartTime is omitted then TimeslotPreferredStartTime is defaulted to TimeslotStartTime. |
| Desirability | An integer or decimal value between 0 and 100. |
| Comment | A string of text in single quotes of the desired comment for the possibility timeslot. Empty string is allowed. |
Examples
Change the timeslot times for a given possibility.
PATCH api/task/TaskA
Body:
{
"SetPossibility" : {
"PossibilityName" : "ResA",
"Timeslot" : {
"Start" : "2015/01/01_07:17:21",
"Stop" : "2015/01/01_07:42:36" ,
"PreferredStartTime" : "2015/01/01_07:20:00:57",
"Comment" : "Edited timeslot" }
}
}
